Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Places renders object in Item properties #5

Merged

Conversation

giorgiobasile
Copy link
Contributor

@giorgiobasile giorgiobasile commented Apr 15, 2024

Changes the JSON Schema, updates examples and docs.

Closes #4

@giorgiobasile giorgiobasile changed the title Places render object in Item properties Places renders object in Item properties Apr 15, 2024
@giorgiobasile giorgiobasile force-pushed the 4-placement-in-items branch 10 times, most recently from a08232c to da0e40f Compare April 16, 2024 14:07
@giorgiobasile giorgiobasile marked this pull request as ready for review April 16, 2024 14:10
@giorgiobasile giorgiobasile mentioned this pull request Apr 16, 2024
@emmanuelmathot
Copy link
Member

seems good to me.

@emmanuelmathot emmanuelmathot self-requested a review April 17, 2024 09:08
Copy link
Member

@emmanuelmathot emmanuelmathot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please just add your changes in the CHANGELOG

@giorgiobasile
Copy link
Contributor Author

giorgiobasile commented Apr 17, 2024

Thanks @emmanuelmathot, I just updated the changelog.
Should I also update already the version number to 2.0.0 or that will be done at release time by you or other maintainers?

@emmanuelmathot
Copy link
Member

We will prepare a PR for the v2 release.

@emmanuelmathot emmanuelmathot merged commit 13ae5c5 into stac-extensions:main Apr 17, 2024
1 check passed
@giorgiobasile giorgiobasile deleted the 4-placement-in-items branch April 17, 2024 09:24
@bmcandr
Copy link

bmcandr commented Oct 30, 2024

Hey, @emmanuelmathot! I'm working on implementing the Render extension in pystac (PR) and noticed that this change moving the renders field into Item properties hasn't been released yet. When do you think this might get released? This change better aligns the extension spec with the Item spec conventions for additional metadata and I'd like the implementation to follow this convention as well.

@emmanuelmathot
Copy link
Member

I have a second thought on this one. Initially, we put renders at top level because it is not a metadata of the items but an 'offering' of the item.
@bmcandr @giorgiobasile, is it problematic of having it at top level for the pystac extension?

@giorgiobasile
Copy link
Contributor Author

Hi @emmanuelmathot, I don't have strong opinions about it, but I'd mention that I proposed this change back then because I was unable to store the renders object using the stac-fastapi transactional API.
We had a discussion here about the issue and how to tackle it, and resolved that the best way forward was to propose the extension change.

But if that changes, I don't see any other blocker - from my limited knowledge - unless other tools may need to be adapted to accept item-level custom fields.

@bmcandr
Copy link

bmcandr commented Oct 30, 2024

Thanks for the quick response @emmanuelmathot and additional context @giorgiobasile!

Are there any other extension specifications that place additional metadata at the top-level on Items? I spot-checked specs and didn't find any. While the Item spec does not restrict additional top-level fields, it looks like the recommended convention of placing additional metadata within Item properties has been informally adopted as a standard practice.

FWIW stac-fastapi-pgstac (maybe all stac-fastapi implementations?) still does not retain additional top-level fields when creating Items. I'm sure it is possible to idiomatically support top-level extension metadata in pystac, but I think it would be the first/only extension to operate this way. I've asked the pystac maintainer for their thoughts.

@emmanuelmathot
Copy link
Member

Are there any other extension specifications that place additional metadata at the top-level on Items? I spot-checked specs and didn't find any. While the Item spec does not restrict additional top-level fields, it looks like the recommended convention of placing additional metadata within Item properties has been informally adopted as a standard practice.

I am not aware of other extension using top level fields.

I think the best is probably to go forward with this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Placement in Items
3 participants